Skip to content

fix(vite-plugin): don't modify ROOT #4249

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

RMHonor
Copy link

@RMHonor RMHonor commented May 24, 2025

Fixes #3624

Stackblitz of the error: https://stackblitz.com/edit/tanstack-router-f8savdzt?file=README.md

The docs state that the routesDirectory should be relative to the cwd (link), however the plugin was attempted to modify the ROOT to whatever was specified in the Vite config.

This caused the generator to look in the wrong directory for the routes and the generated route tree.

Simply removing this modification of ROOT so the behaviour matches the plugin.

Is this a breaking change? No, the current behaviour doesn't work, and the workarounds (using an absolute route directory path) would not be broken when pulling this change.

Copy link

nx-cloud bot commented May 24, 2025

View your CI Pipeline Execution ↗ for commit 90b850c.

Command Status Duration Result
nx affected --targets=test:eslint,test:unit,tes... ❌ Failed 4m 51s View ↗
nx run-many --target=build --exclude=examples/*... ✅ Succeeded 1m 10s View ↗

☁️ Nx Cloud last updated this comment at 2025-05-27 04:43:09 UTC

@schiller-manuel
Copy link
Contributor

we should use this in one of the examples to ensure this does not regress

Copy link

pkg-pr-new bot commented May 24, 2025

More templates

@tanstack/arktype-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/arktype-adapter@4249

@tanstack/directive-functions-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/directive-functions-plugin@4249

@tanstack/eslint-plugin-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/eslint-plugin-router@4249

@tanstack/history

npm i https://pkg.pr.new/TanStack/router/@tanstack/history@4249

@tanstack/react-router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router-devtools@4249

@tanstack/react-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router@4249

@tanstack/react-router-with-query

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router-with-query@4249

@tanstack/react-start

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start@4249

@tanstack/react-start-client

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-client@4249

@tanstack/react-start-config

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-config@4249

@tanstack/react-start-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-plugin@4249

@tanstack/react-start-router-manifest

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-router-manifest@4249

@tanstack/react-start-server

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-server@4249

@tanstack/router-cli

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-cli@4249

@tanstack/router-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-core@4249

@tanstack/router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-devtools@4249

@tanstack/router-devtools-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-devtools-core@4249

@tanstack/router-generator

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-generator@4249

@tanstack/router-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-plugin@4249

@tanstack/router-utils

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-utils@4249

@tanstack/router-vite-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-vite-plugin@4249

@tanstack/server-functions-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/server-functions-plugin@4249

@tanstack/solid-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router@4249

@tanstack/solid-router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router-devtools@4249

@tanstack/solid-start

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start@4249

@tanstack/solid-start-client

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-client@4249

@tanstack/solid-start-config

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-config@4249

@tanstack/solid-start-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-plugin@4249

@tanstack/solid-start-router-manifest

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-router-manifest@4249

@tanstack/solid-start-server

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-server@4249

@tanstack/start

npm i https://pkg.pr.new/TanStack/router/@tanstack/start@4249

@tanstack/start-api-routes

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-api-routes@4249

@tanstack/start-client-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-client-core@4249

@tanstack/start-config

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-config@4249

@tanstack/start-server-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-core@4249

@tanstack/start-server-functions-client

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-functions-client@4249

@tanstack/start-server-functions-fetcher

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-functions-fetcher@4249

@tanstack/start-server-functions-handler

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-functions-handler@4249

@tanstack/start-server-functions-server

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-functions-server@4249

@tanstack/start-server-functions-ssr

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-functions-ssr@4249

@tanstack/valibot-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/valibot-adapter@4249

@tanstack/virtual-file-routes

npm i https://pkg.pr.new/TanStack/router/@tanstack/virtual-file-routes@4249

@tanstack/zod-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/zod-adapter@4249

commit: 90b850c

@RMHonor
Copy link
Author

RMHonor commented May 24, 2025

@schiller-manuel good idea, I've added it to the kitchen sink example so it doesn't add complexity to the simpler ones

Copy link
Member

@SeanCassiere SeanCassiere left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a separate example to this one. Perhaps, even add it into the end-to-end testing suite.

@RMHonor
Copy link
Author

RMHonor commented May 26, 2025

@SeanCassiere I've used the basic file based e2e test here, all looks good.

@SeanCassiere
Copy link
Member

@RMHonor Small miscommunication on my part.

Don't modify any of the existing sandboxes. Rather, add a new one.

@RMHonor
Copy link
Author

RMHonor commented May 27, 2025

@SeanCassiere I follow now, thanks.

What tests would you include in this scenario? I was thinking it could be a good opportunity to have a "custom config" suite.

@SeanCassiere
Copy link
Member

@SeanCassiere I follow now, thanks.

What tests would you include in this scenario? I was thinking it could be a good opportunity to have a "custom config" suite.

Doesn't need to be anything crazy. Just make sure that it can navigate from page to page.

@schiller-manuel
Copy link
Contributor

i am currently rewriting the generator and the plugins. can you please provide the example in this PR and I will then pick it onto my branch once I am done? trying to avoid merge conflicts

@RMHonor
Copy link
Author

RMHonor commented May 29, 2025

@SeanCassiere modified the e2e tests with this new suite.

@schiller-manuel I've added a stackblitz link in the description, and the new e2e scenario also showcases the expected behaviour with the fix.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

routeTree generation breaks when using different root in vite config
3 participants